//
// PepSessionVariable
//
// Copyright (C) 2007 Brian Stevens.
//
//  This file is part of the JavaPepper Library.
//
//  The JavaPepper Library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 2.1 of the License, or (at your option) any later version.
//
//  The JavaPepper Library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with the JavaPepper Library; if not, write to the Free
//  Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
//  02111-1307 USA.
//

package net.jextra.javapepper;

import java.lang.annotation.*;

/**
 * <p>
 * A PepSessionVariable annotation is recognized in a {@link PepResponder} as a registration of the field into the user's
 * HttpSession "scope".
 * </p>
 * <p>
 * What this means is that the variable value will not change for the entire time a particular end-user is interacting
 * with the web server.
 * </p>
 * <p>
 * Session variables are very useful for relaying information between temporally disparate {@link PepResponder}'s that are
 * intended for the same end-user.
 * </p>
 * <p>
 * Session variables are also helpful for storing user state.
 * </p>
 */
@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.FIELD )
public @interface PepSessionVariable
{
    String value() default "";

    boolean autoConstruct() default true;
}
